<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: APL.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Alexa Auto SDK
   &#160;<span id="projectnumber">2.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_e05d7e2b1ecd646af5bb94391405f3b5.html">modules</a></li><li class="navelem"><a class="el" href="dir_eb947337e773576782d15e93b73a2d36.html">apl</a></li><li class="navelem"><a class="el" href="dir_898a68d23589ea180cf04f1d3a896abd.html">platform</a></li><li class="navelem"><a class="el" href="dir_cf8947b0d41b7cd3189312d3a31799a2.html">include</a></li><li class="navelem"><a class="el" href="dir_ea6c9ea6bfee00f1120438f6115c6fb1.html">AACE</a></li><li class="navelem"><a class="el" href="dir_9e24cef1954011711f50e178c2fad908.html">APL</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">APL.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2019-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;).</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * You may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * A copy of the License is located at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://aws.amazon.com/apache2.0/</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * or in the &quot;license&quot; file accompanying this file. This file is distributed</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * express or implied. See the License for the specific language governing</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * permissions and limitations under the License.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef AACE_APL_APL_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define AACE_APL_APL_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;AACE/Core/PlatformInterface.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;APLEngineInterface.h&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceaace.html">aace</a> {</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">namespace </span>apl {</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classaace_1_1apl_1_1_a_p_l.html">   36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> : <span class="keyword">public</span> <a class="code" href="classaace_1_1core_1_1_platform_interface.html">aace::core::PlatformInterface</a> {</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <a class="code" href="classaace_1_1apl_1_1_a_p_l.html">APL</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keyword">using</span> ActivityEvent = aace::apl::APLEngineInterface::ActivityEvent;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="classaace_1_1apl_1_1_a_p_l.html">APL</a>();</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keyword">virtual</span> std::string <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a97bcf6e8f7709626c6e5f9b2b06861ef">getVisualContext</a>() = 0;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a605da3ae66ca91baa83f71442e0c4273">renderDocument</a>(<span class="keyword">const</span> std::string&amp; jsonPayload, <span class="keyword">const</span> std::string&amp; token, <span class="keyword">const</span> std::string&amp; windowId) = 0;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a9659ffea560f0be933c506a0bba2de13">clearDocument</a>() = 0;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a14091f7b0a6e8898098d04ec67abac8c">executeCommands</a>(<span class="keyword">const</span> std::string&amp; jsonPayload, <span class="keyword">const</span> std::string&amp; token) = 0;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#abe1e559640f83434304f1b2b826fda62">interruptCommandSequence</a>() = 0;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a6831186c4572d71e2094271563c1a805">clearCard</a>();</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a7ea358a32c50da5fbe733bb370e640a2">clearAllExecuteCommands</a>();</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a650185d2e461fa04a54ca6389cea9b7e">sendUserEvent</a>(<span class="keyword">const</span> std::string&amp; payload);</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#ae78b5ed9cf53ac882d12bdff99d69638">setAPLMaxVersion</a>(<span class="keyword">const</span> std::string&amp; aplMaxVersion);</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#ad6270378b772440b1d4679b844d4d928">setDocumentIdleTimeout</a>(std::chrono::milliseconds documentIdleTimeout);</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a42ad9effa8cb1ae3ca95fa65c3378993">renderDocumentResult</a>(<span class="keyword">const</span> std::string&amp; token, <span class="keyword">const</span> <span class="keywordtype">bool</span> result, <span class="keyword">const</span> std::string&amp; error);</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a3599f0eec806b4e0d1315ca1f1e8d1b1">executeCommandsResult</a>(<span class="keyword">const</span> std::string&amp; token, <span class="keyword">const</span> <span class="keywordtype">bool</span> result, <span class="keyword">const</span> std::string&amp; error);</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaace_1_1apl_1_1_a_p_l.html#a1e382051d18bc09a39e1f3cd9b9ddb9a">processActivityEvent</a>(<span class="keyword">const</span> std::string&amp; source, <span class="keyword">const</span> ActivityEvent event);</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="keywordtype">void</span> setEngineInterface(std::shared_ptr&lt;APLEngineInterface&gt; aplEngineInterface);</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    std::shared_ptr&lt;APLEngineInterface&gt; m_aplEngineInterface;</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;};</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;}  <span class="comment">// namespace apl</span></div><div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;}  <span class="comment">// namespace aace</span></div><div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html">aace::apl::APL</a></div><div class="ttdef"><b>Definition:</b> APL.h:36</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a1e382051d18bc09a39e1f3cd9b9ddb9a"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a1e382051d18bc09a39e1f3cd9b9ddb9a">aace::apl::APL::processActivityEvent</a></div><div class="ttdeci">void processActivityEvent(const std::string &amp;source, const ActivityEvent event)</div><div class="ttdef"><b>Definition:</b> APL.cpp:69</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a14091f7b0a6e8898098d04ec67abac8c"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a14091f7b0a6e8898098d04ec67abac8c">aace::apl::APL::executeCommands</a></div><div class="ttdeci">virtual void executeCommands(const std::string &amp;jsonPayload, const std::string &amp;token)=0</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a605da3ae66ca91baa83f71442e0c4273"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a605da3ae66ca91baa83f71442e0c4273">aace::apl::APL::renderDocument</a></div><div class="ttdeci">virtual void renderDocument(const std::string &amp;jsonPayload, const std::string &amp;token, const std::string &amp;windowId)=0</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a7ea358a32c50da5fbe733bb370e640a2"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a7ea358a32c50da5fbe733bb370e640a2">aace::apl::APL::clearAllExecuteCommands</a></div><div class="ttdeci">void clearAllExecuteCommands()</div><div class="ttdef"><b>Definition:</b> APL.cpp:33</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a9659ffea560f0be933c506a0bba2de13"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a9659ffea560f0be933c506a0bba2de13">aace::apl::APL::clearDocument</a></div><div class="ttdeci">virtual void clearDocument()=0</div></div>
<div class="ttc" id="classaace_1_1core_1_1_platform_interface_html"><div class="ttname"><a href="classaace_1_1core_1_1_platform_interface.html">aace::core::PlatformInterface</a></div><div class="ttdef"><b>Definition:</b> PlatformInterface.h:29</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a97bcf6e8f7709626c6e5f9b2b06861ef"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a97bcf6e8f7709626c6e5f9b2b06861ef">aace::apl::APL::getVisualContext</a></div><div class="ttdeci">virtual std::string getVisualContext()=0</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a6831186c4572d71e2094271563c1a805"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a6831186c4572d71e2094271563c1a805">aace::apl::APL::clearCard</a></div><div class="ttdeci">void clearCard()</div><div class="ttdef"><b>Definition:</b> APL.cpp:27</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a3599f0eec806b4e0d1315ca1f1e8d1b1"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a3599f0eec806b4e0d1315ca1f1e8d1b1">aace::apl::APL::executeCommandsResult</a></div><div class="ttdeci">void executeCommandsResult(const std::string &amp;token, const bool result, const std::string &amp;error)</div><div class="ttdef"><b>Definition:</b> APL.cpp:63</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_abe1e559640f83434304f1b2b826fda62"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#abe1e559640f83434304f1b2b826fda62">aace::apl::APL::interruptCommandSequence</a></div><div class="ttdeci">virtual void interruptCommandSequence()=0</div></div>
<div class="ttc" id="namespaceaace_html"><div class="ttname"><a href="namespaceaace.html">aace</a></div><div class="ttdef"><b>Definition:</b> AddressBook.h:26</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a650185d2e461fa04a54ca6389cea9b7e"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a650185d2e461fa04a54ca6389cea9b7e">aace::apl::APL::sendUserEvent</a></div><div class="ttdeci">void sendUserEvent(const std::string &amp;payload)</div><div class="ttdef"><b>Definition:</b> APL.cpp:39</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_ae78b5ed9cf53ac882d12bdff99d69638"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#ae78b5ed9cf53ac882d12bdff99d69638">aace::apl::APL::setAPLMaxVersion</a></div><div class="ttdeci">void setAPLMaxVersion(const std::string &amp;aplMaxVersion)</div><div class="ttdef"><b>Definition:</b> APL.cpp:45</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_ad6270378b772440b1d4679b844d4d928"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#ad6270378b772440b1d4679b844d4d928">aace::apl::APL::setDocumentIdleTimeout</a></div><div class="ttdeci">void setDocumentIdleTimeout(std::chrono::milliseconds documentIdleTimeout)</div><div class="ttdef"><b>Definition:</b> APL.cpp:51</div></div>
<div class="ttc" id="classaace_1_1apl_1_1_a_p_l_html_a42ad9effa8cb1ae3ca95fa65c3378993"><div class="ttname"><a href="classaace_1_1apl_1_1_a_p_l.html#a42ad9effa8cb1ae3ca95fa65c3378993">aace::apl::APL::renderDocumentResult</a></div><div class="ttdeci">void renderDocumentResult(const std::string &amp;token, const bool result, const std::string &amp;error)</div><div class="ttdef"><b>Definition:</b> APL.cpp:57</div></div>
</div><!-- fragment --></div><!-- contents -->
<html>
  <body>
    <hr style="height:1px;border-width:0;color:gray;background-color:gray">
    <p style="text-align:left;">
      Alexa Auto SDK 2.2.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
      <span style="float:right;">
        Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
      </span>
    </p>
  </body>
</html>
